Skip to content

docs(source-zendesk-support): improve OAuth authentication documentation #72390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
devin-ai-integration wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

docs(source-zendesk-support): improve OAuth authentication documentation #72390

devin-ai-integration wants to merge 2 commits into from
+23 −10

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Jan 27, 2026 •
edited
Loading

What

Improves the Zendesk Support connector documentation to better explain the OAuth authentication options following the recent addition of OAuth 2.0 with refresh token support in version 5.0.0.

This documentation update was triggered by reviewing commit d04dff3 which fixed an OAuth race condition with concurrent token refresh.

How

  1. Updated the main documentation (zendesk-support.md) to:

    • List all three authentication methods (OAuth 2.0 with Refresh Token, API Token, OAuth 2.0 Legacy)
    • Add context about Zendesk's deadline for OAuth refresh token adoption (April 30, 2026)
    • Update setup instructions to reference the new OAuth option name

  2. Enhanced the migration guide (zendesk-support-migrations.md) to:

    • Explain why Zendesk is requiring this change
    • Describe how rotating refresh tokens work
    • Add a "Who is affected" section
    • Link to Zendesk's official announcement

Updates since last revision

  • Fixed invalid link fragment: changed #set-up-the-zendesk-support-source-connector to #set-up-the-zendesk-support-connector-in-airbyte to match the actual heading (flagged by markdownlint)

Review guide

  1. docs/integrations/sources/zendesk-support.md - Main documentation updates
  2. docs/integrations/sources/zendesk-support-migrations.md - Migration guide enhancements

Human review checklist:

  • Verify the April 30, 2026 deadline matches Zendesk's official announcement
  • Confirm the external link to Zendesk's article works correctly
  • Ensure authentication method names match what users see in the Airbyte UI

User Impact

Users will have clearer documentation explaining:

  • The three available authentication methods and when to use each
  • Why they need to re-authenticate if using OAuth (Zendesk's requirement)
  • The timeline for Zendesk's OAuth changes

Can this PR be safely reverted and rolled back?

  • YES 💚

Note

This PR was created by Devin, an AI assistant. These documentation updates were proposed based on reviewing recent connector changes. Reviewers may merge, modify, or close this PR as appropriate.

Link to Devin run: https://app.devin.ai/sessions/c45528251b32462785b859886dadcf7a

@devin-ai-integration
docs(source-zendesk-support): improve OAuth authentication documentation
afe82eb 
- Update authentication section to list all three methods (OAuth 2.0 with Refresh Token, API Token, OAuth 2.0 Legacy)
- Add information about Zendesk's OAuth refresh token deadline (April 30, 2026)
- Enhance migration guide for 5.0.0 with context about Zendesk's OAuth changes
- Add link to Zendesk's OAuth refresh token announcement

Co-Authored-By: unknown <>
@devin-ai-integration
Copy link
Contributor Author

devin-ai-integration bot commented Jan 27, 2026

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@devin-ai-integration devin-ai-integration bot added area/documentation Improvements or additions to documentation team/documentation labels Jan 27, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 27, 2026

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

💡 Show Tips and Tricks

PR Slash Commands

Airbyte Maintainers (that's you!) can execute the following slash commands on your PR:

  • 🛠️ Quick Fixes
    • /format-fix - Fixes most formatting issues.
    • /bump-version - Bumps connector versions, scraping changelog description from the PR title.
  • ❇️ AI Testing and Review:
    • /ai-docs-review - Provides AI-powered documentation recommendations for PRs with connector changes.
    • /ai-prove-fix - Runs prerelease readiness checks, including testing against customer connections.
    • /ai-canary-prerelease - Rolls out prerelease to 5-10 connections for canary testing.
    • /ai-review - AI-powered PR review for connector safety and quality gates.
  • 🚀 Connector Releases:
    • /publish-connectors-prerelease - Publishes pre-release connector builds (tagged as {version}-preview.{git-sha}) for all modified connectors in the PR.
    • /bump-progressive-rollout-version - Bumps connector version with an RC suffix (2.16.10-rc.1) for progressive rollouts (enableProgressiveRollout: true).
      • Example: /bump-progressive-rollout-version changelog="Add new feature for progressive rollout"
  • ☕️ JVM connectors:
    • /update-connector-cdk-version connector=<CONNECTOR_NAME> - Updates the specified connector to the latest CDK version.
      Example: /update-connector-cdk-version connector=destination-bigquery
    • /bump-bulk-cdk-version bump=patch changelog='foo' - Bump the Bulk CDK's version. bump can be major/minor/patch.
  • 🐍 Python connectors:
    • /poe connector source-example lock - Run the Poe lock task on the source-example connector, committing the results back to the branch.
    • /poe source example lock - Alias for /poe connector source-example lock.
    • /poe source example use-cdk-branch my/branch - Pin the source-example CDK reference to the branch name specified.
    • /poe source example use-cdk-latest - Update the source-example CDK dependency to the latest available version.
  • ⚙️ Admin commands:
    • /force-merge reason="<REASON>" - Force merges the PR using admin privileges, bypassing CI checks. Requires a reason.
      Example: /force-merge reason="CI is flaky, tests pass locally"
📚 Show Repo Guidance

Helpful Resources

📝 Edit this welcome message.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 27, 2026 •
edited
Loading

Deploy preview for airbyte-docs ready!

✅ Preview
https://airbyte-docs-ncty1scuv-airbyte-growth.vercel.app

Built with commit 4c49c19.
This pull request is being automatically deployed with vercel-action

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ian-at-airbyte ian-at-airbyte Awaiting requested review from ian-at-airbyte

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

area/documentation Improvements or additions to documentation team/documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

0 participants